home *** CD-ROM | disk | FTP | other *** search
/ Aminet 3 / Aminet 3 - July 1994.iso / Aminet / util / cli / ADoc2_v400.lha / ADoc / ADoc.doc < prev    next >
Encoding:
Text File  |  1994-05-14  |  29.7 KB  |  629 lines
  1.  
  2.  
  3.                ADoc - Manuel de référence
  4.  
  5.  
  6.  
  7.  
  8.  
  9. AboutThisDoc
  10.    
  11.       Ce manuel décrit la version 4.00 de l'utilitaire ADoc. Ce  programme
  12.   est (c)1990-1994 par Denis GOUNELLE, toute utilisation commerciale ou  vente
  13.   sans autorisation écrite est strictement interdite. Vous  pouvez  copier  et
  14.   diffuser ce programme aux conditions suivantes :
  15.  
  16.     - l'ensemble des fichiers doit être fourni
  17.     - aucun fichier ne doit avoir été modifié
  18.     - vous ne devez pas demander plus de 40FF pour cela
  19.    
  20.       Malgré de nombreux tests, je ne peux garantir que ADoc  ne  contient
  21.   aucune erreur. VOUS UTILISEZ CE PROGRAMME A VOS RISQUES  ET  PERILS.  Je  ne
  22.   pourrai en aucun cas être tenu pour responsable de tout dommage,  direct  ou
  23.   indirect, résultant de l'utilisation de ADoc.
  24.    
  25.   AREXX est (c)1987 par William Hawes.
  26.   PowerPacker 2.3b est (c)1989 par PowerPeak et Nico FRANCOIS
  27.   PowerPacker Pro 3.0b est (c)1990 par PowerPeak et par UGA Software.
  28.   La bibliothèque "powerpacker.library" est (c)1990 par Nico FRANCOIS.
  29.   La bibliothèque "reqtools.library" est (c)1990 par Nico FRANCOIS.
  30.    
  31.           >>> FERMEZ CETTE FENETRE POUR CONTINUER <<<
  32.    
  33. Introduction
  34.    
  35.       ADoc2  est  une  nouvelle  version  de  ADoc,  qui  a  été   réécrit
  36.   entièrement afin de supprimer certaines limitations et de pouvoir ajouter de
  37.   nombreuses  améliorations.  Notez  que   certaines   incompatibilités   sont
  38.   apparues, principalement au niveau des arguments. Ce programme fonctionne de
  39.   la même façon sous les versions 1.3 et 2.0 du système. 
  40.       ADoc est un utilitaire permettant de gérer  des  documentations  sur
  41.   n'importe quel sujet. Il est capable de lancer automatiquement la  recherche
  42.   d'un mot désigné à la souris, et peut travailler sur plusieurs fichiers à la
  43.   fois. ADoc peut également  utiliser  directement  les  fichiers  AutoDoc  et
  44.   AmigaGuide, ainsi que  des  fichiers  compactés  à  l'aide  de  l'utilitaire
  45.   "PowerPacker".
  46.  
  47.       Vos critiques et suggestions sur ce programme  seront  toujours  les
  48.   bienvenues. N'hésitez pas à m'écrire, à l'adresse suivante :
  49.  
  50.                    M. GOUNELLE Denis
  51.                   27, rue Jules GUESDE
  52.                 45400 FLEURY-LES-AUBRAIS
  53.                      FRANCE
  54.    
  55.       Vous pouvez également m'adresser un  message  à  l'adresse  Internet
  56.   "gounelle@alphanet.ch". Notez qu'il s'agit d'une boite à lettre  mise  à  ma
  57.   disposition par un ami, aussi veuillez n'envoyer que de courts messages.  De
  58.   plus, n'ayant pas accès directement à mes messages, n'espérez pas avoir  une
  59.   réponse avant une dizaine de jours.
  60.    
  61.       Merci  à  Jean-Yves  PROUX  et  à  Helmut  J.  ESENWEIN  pour  leurs
  62.   nombreuses suggestions, à Reza ELGHAZI pour son aide à propos  des  fichiers
  63.   AmigaGuide, ainsi qu'à Simon HEWINSON  pour  la  traduction  en  anglais  du
  64.   fichier "amiga.doc". Remerciements particuliers à  Jean-Philippe  RAPP  pour
  65.   ses idées, et pour son aide à propos des fichiers AutoDoc.
  66.  
  67. Installation
  68.    
  69.       ADoc utilise la bibliothèque  "reqtools.library"  (version  2.0c  ou
  70.   supérieure). Vous devez donc copier cette bibliothèque  dans  le  répertoire
  71.   "LIBS:", si ce n'est déjà fait. 
  72.       ADoc est désormais localisé, c'est-à-dire qu'il peut s'adapter à  la
  73.   langue par défaut si vous avez le système 2.1 ou plus. Il vous faudra  alors
  74.   copier le fichier catalogue désiré dans le répertoire correspondant à  votre
  75.   langue par défaut. Par exemple, s'il s'agit du français, copiez  le  fichier
  76.   "français.catalog" dans le répertoire  "SYS:Locale/Catalogs/Français",  sous
  77.   le nom "ADoc.catalog"
  78.    
  79. PrincipesDeFonctionnement
  80.    
  81.       ADoc travaille à partir de fichiers de documentation, qui  associent
  82.   un texte à un mot-clé (appelé "terme" dans cette  documentation).  A  chaque
  83.   fichier  de  documentation  est  associé  un  fichier  d'index,  qui  permet
  84.   d'accéder presque instantanément aux termes recherchés  (notez  que  ceci  a
  85.   pour conséquence qu'il faudra  reconstruire  le  fichier  d'index  à  chaque
  86.   modification du fichier de  documentation).  Seul  le  fichier  d'index  est
  87.   chargé en mémoire lors de l'utilisation.  Le  nom  du  fichier  d'index  est
  88.   obtenu en ajoutant le suffixe ".index" au nom du fichier de documentation.
  89.  
  90.       Les fichiers de documentation, que vous  pouvez  créer  vous-même  à
  91.   l'aide de votre éditeur de texte favori,  sont  constitués  d'une  série  de
  92.   définitions, chaque définition ayant la syntaxe suivante :
  93.  
  94.           terme
  95.               première ligne de texte
  96.               seconde ligne de texte
  97.                
  98.               etc...
  99.                
  100.               n-ième ligne de texte
  101.    
  102.       Dans un premier temps, considérez que les deux premières  lignes  du
  103.   fichier doivent être vides (ou à la rigueur commencer par un espace  ou  une
  104.   tabulation). Il est absolument indispensable que  le  premier  caractère  du
  105.   terme soit en colonne 1, et que les lignes de texte commencent par un espace
  106.   ou une tabulation. Les lignes vides sont autorisées.
  107.  
  108.       Un terme ne peut faire plus de 32 caractères, et ne peut contenir ni
  109.   espaces  ni  tabulations  :  les  caractères  autorisés  sont  les   lettres
  110.   minuscules et majuscules,  les  chiffres,  le  souligné  et  les  caractères
  111.   accentués (codes ASCII compris entre 217 et 246). Il est cependant  possible
  112.   d'étendre le  jeu  des  caractères  autorisés  si  besoin  (voir  paragraphe
  113.   ConceptsAvancés). 
  114.       Le nombre de termes par fichier, et de lignes de texte par terme, ne
  115.   sont pas limités (ou plutôt, cette limite est si grande  que  vous  serez  à
  116.   court de mémoire bien avant).
  117.  
  118.       La longueur maximale d'une ligne de texte  est  de  256  caractères.
  119.   Afin de mettre en valeur certaines parties du texte,  vous  pouvez  utiliser
  120.   les séquences ANSI suivantes :
  121.  
  122.           ESC[1m  début caractères gras
  123.           ESC[3m  début caractères italiques
  124.           ESC[4m  début caractères soulignés
  125.           ESC[22m fin caractères gras
  126.           ESC[23m fin caractères italiques
  127.           ESC[24m fin caractères soulignés
  128.           ESC[0m  caractères normaux
  129.    
  130. AppelDepuisLeCLI
  131.    
  132.   ADoc peut s'utiliser aussi bien depuis le CLI que depuis le Workbench.  Lors
  133.   de l'appel depuis le CLI, vous pouvez indiquer les arguments suivants :
  134.  
  135.   WBENCH 
  136.       Demande à ADoc d'utiliser l'écran du  Workbench.  Si  cet  argument  est
  137.       omis, ADoc ouvrira son propre écran, de la même taille  que  l'écran  du
  138.       Workbench. En cas d'erreur  lors  de  l'ouverture  de  cet  écran,  ADoc
  139.       passera automatiquement sur l'écran du Workbench.
  140.  
  141.   LACE 
  142.       Demande à ADoc d'utiliser un écran  en  mode  entrelacé.  Si  vous  avez
  143.       demandé à utiliser l'écran du Workbench, et que cet écran n'est  pas  en
  144.       mode entrelacé, cet argument sera ignoré.
  145.  
  146.   DEPTH n 
  147.       Demande à ADoc d'utiliser un  écran  de  n  plans  (ce  qui  permet  2^n
  148.       couleurs). Si vous avez demandé à utiliser  l'écran  du  Workbench,  cet
  149.       argument sera ignoré.
  150.  
  151.   FONT nom 
  152.       Demande à ADoc d'utiliser la police de caractères indiquée,  plutôt  que
  153.       la   police   par   défaut.   Le   nom   doit   être   de    la    forme
  154.       <NomDeLaPolice><TailleEnY>,  par  exemple  "topaz8".  ADoc  est  capable
  155.       d'utiliser n'importe quelle police non proportionnelle,  pourvu  que  sa
  156.       taille soit d'au moins 8. 
  157.       Si ADoc ne peut ouvrir la police demandée,  il  essaiera  d'utiliser  la
  158.       police par défaut. Si cette police ne convient pas, ou si ADoc  ne  peut
  159.       l'ouvrir, il essaiera d'accéder à la police Topaz,  en  taille  8.  S'il
  160.       échoue, le programme s'arrêtera immédiatement.
  161.  
  162.   MAKEIDX 
  163.       Indique à ADoc que la seule opération à effectuer est  la  création  des
  164.       fichiers d'index.
  165.  
  166.   QUICK 
  167.       Demande  à  ADoc  de  ne  pas  afficher  le  texte  associé   au   terme
  168.       "AboutThisDoc" au démarrage. Normalement, à chaque fois que  ADoc  ouvre
  169.       un fichier, il cherche le terme "AboutThisDoc"  dans  ce  fichier  puis,
  170.       s'il existe,  affiche le texte correspondant et attend que l'utilisateur
  171.       ferme la fenêtre pour continuer.
  172.  
  173.   AREXX 
  174.       Demande à ADoc de passer en mode AREXX.  L'utilisation  avec  AREXX  est
  175.       détaillée au paragraphe ModeAREXX.
  176.  
  177.   ONEWINDOW 
  178.       Demande à ADoc de n'ouvrir qu'une seule fenêtre à la fois.
  179.  
  180.   NOCASE 
  181.       Demande à ADoc de ne pas différencier minuscules et majuscules  lors  de
  182.       la gestion des fichiers. Cela ne concernera que les fichiers dont le nom
  183.       est indiqué après cette option.
  184.  
  185.   NOSORT 
  186.       Demande à ADoc de ne pas trier l'index des  fichiers  dont  le  nom  est
  187.       indiqué après cette option.
  188.  
  189.   TABSIZE n 
  190.       Indique la taille des tabulations pour les  fichiers  dont  le  nom  est
  191.       indiqué après cette option. La taille par défaut est de 8. 
  192.    
  193.   Tout autre argument est considéré comme un nom de fichier de documentation à
  194.   utiliser. Vous pouvez indiquer plusieurs fichiers, en séparant les noms  par
  195.   des espaces ou par une virgule (par  exemple  "ADoc  fichier1  fichier2"  ou
  196.   "ADoc fichier1,fichier2"). Vous pouvez mélanger noms de fichiers et options,
  197.   mais  n'oubliez  pas  que  les  options  NOCASE,  NOSORT,  et   TABSIZE   ne
  198.   concerneront que les fichiers indiqués après ces options. ADoc  ouvrira  les
  199.   fichiers dans l'ordre indiqué.  A  moins  que  vous  n'indiquiez  un  chemin
  200.   complet, les fichiers sont recherchés d'abord dans  le  répertoire  courant,
  201.   puis dans le répertoire "ADOC:". Si vous indiquez un nom  de  répertoire  au
  202.   lieu d'un nom de fichier, tous les fichiers de ce répertoire (à  l'exception
  203.   des fichiers ".info" et ".index") seront ouverts.
  204.  
  205. AppelDepuisLeWorkbench
  206.    
  207.   Depuis le Workbench, vous pouvez appeler ADoc de plusieurs façons :
  208.  
  209.     - en double-cliquant sur l'icône de ADoc (le fichier de documentation  par
  210.       défaut sera utilisé) 
  211.     - en double-cliquant sur l'icône d'un fichier qui a ADoc comme  outil  par
  212.       défaut (champ "DEFAULT TOOL") 
  213.     - en cliquant sur les icônes de plusieurs fichiers,  tout  en  gardant  la
  214.       touche SHIFT appuyée, puis en double-cliquant sur l'icône de ADoc. 
  215.    
  216.   Dans tous les cas, ADoc commence par  examiner  le  champ  "TOOL  TYPES"  de
  217.   l'icône du programme, qui peut contenir :
  218.  
  219.       FONT=nom 
  220.       DEPTH=n 
  221.       OPTIONS=[WBENCH][LACE][MAKEIDX][QUICK][AREXX][ONEWINDOW]
  222.  
  223.   Pour plus de détails sur ces options, voir le  paragraphe  AppelDepuisLeCLI.
  224.   Notez que les noms des options doivent être séparés par  un  caractère  "|".
  225.   ADoc ouvre ensuite les fichiers  de  documentation  éventuellement  indiqués
  226.   exactement de la même façon que lors de l'appel  depuis  le  CLI  (notamment
  227.   vous pouvez indiquer un répertoire au lieu d'un fichier),  à  la  différence
  228.   que le champ "TOOL TYPES" de chaque icône est examiné, et peut contenir :
  229.  
  230.       TABSIZE=n 
  231.       OPTIONS=[NOCASE][NOSORT]
  232.  
  233.   Pour plus de détails sur ces options, voir le  paragraphe  AppelDepuisLeCLI.
  234.   Notez que ces trois options ne concerneront que le fichier  correspondant  à
  235.   l'icône.
  236.  
  237. DémarrageDuProgramme
  238.    
  239.       Comme expliqué dans les deux paragraphes précédents,  ADoc  commence
  240.   par ouvrir le (ou les) fichier(s) indiqué(s).  Lors  de  cette  phase,  ADoc
  241.   tente également de charger le fichier d'index correspondant à chaque fichier
  242.   de documentation. Si vous n'avez indiqué aucun nom de fichier à ouvrir, ADoc
  243.   regarde si la variable "ADocFile" est  définie  :  si  oui,  sa  valeur  est
  244.   utilisée. Si non, le fichier de documentation par  défaut  est  "Amiga.doc".
  245.   Notez  que  vous  pouvez  indiquer  plusieurs  fichiers  dans  la   variable
  246.   "ADocFile", de la même façon que depuis la ligne de commande  (par  exemple:
  247.   setenv ADocFile "exec.doc dos.doc"). 
  248.       Si le fichier d'index est introuvable, ADoc  vous  proposera  de  le
  249.   créer. Si vous refusez, ce fichier de documentation ne sera pas  utilisable,
  250.   mais ADoc essaiera quand même d'ouvrir les autres fichiers. 
  251.       Si ADoc détecte que le fichier de documentation a été modifié  après
  252.   la création de l'index, il vous proposera de mettre  le  fichier  d'index  à
  253.   jour. Si vous refusez, le fichier de documentation sera quand  même  ouvert,
  254.   mais ADoc pourra détecter des erreurs ultérieurement si  le  contenu  de  ce
  255.   fichier a été changé. Notez que la date de création du fichier  d'index  est
  256.   mémorisée dans le fichier d'index lui-même.
  257.  
  258.       Une fois tous les  fichiers  ouverts,  ADoc  affiche  une  boîte  de
  259.   requête,  indiquant  la  liste  des  termes  du  premier   fichier   ouvert.
  260.   L'utilisation  de  cette  boîte  de  requête  est  décrite   au   paragraphe
  261.   RequêteDeTerme.
  262.  
  263. RequêteDeTerme
  264.    
  265.       Vous pouvez désigner un terme à l'aide de  la  souris,  en  cliquant
  266.   dessus. Le terme s'affiche alors dans une autre couleur. Si vous cliquez une
  267.   seconde fois sur ce terme, la requête disparait et  ADoc  affiche  le  texte
  268.   correspondant au terme dans une fenêtre. L'utilisation de ces  fenêtres  est
  269.   décrite au paragraphe GestionDesFenêtres.
  270.  
  271.       Vous pouvez également vous servir du clavier pour faire votre choix.
  272.   Si vous appuyez sur une lettre quelconque,  cette  lettre  sera  ajoutée  au
  273.   "préfixe" courant (affiché dans le rectangle en  dessous  de  la  liste  des
  274.   termes), et l'affichage de la liste des termes se fera à partir  du  premier
  275.   terme commençant  par  ce  préfixe.  ADoc  complètera  ce  préfixe  le  plus
  276.   possible. Si vous appuyez sur la touche <BACKSPACE> (au-dessus de la  touche
  277.   <RETURN>), le dernier caractère du préfixe sera effacé et l'affichage de  la
  278.   liste mis à jour également. Si vous appuyez sur  la  touche  <RETURN>,  ADoc
  279.   affichera le texte correspondant au premier terme commençant par le préfixe.
  280.   Notez que ADoc ne différenciera pas  minuscules et majuscules si le  fichier
  281.   courant a été indiqué après une option NOCASE.
  282.  
  283.       Vous pouvez fermer la requête sans rien choisir, en appuyant sur  la
  284.   touche <ESC> ou en cliquant sur le gadget  de  fermeture.  Si  aucune  autre
  285.   fenêtre n'est ouverte à ce moment, le programme s'arrêtera.
  286.  
  287.       La requête de terme est en fait capable de vous permettre  un  choix
  288.   parmi trois listes : la liste des termes du fichier courant,  la  liste  des
  289.   fichiers (à condition qu'il y ait plusieurs fichiers ouverts)  et  la  liste
  290.   des termes trouvés  lors  de  la  dernière  recherche  (à  condition  qu'une
  291.   recherche ait déjà été effectuée,  voir  paragraphe  Recherche).  La  lettre
  292.   écrite dans le coin inférieur droit de la requête vous indique quelle  liste
  293.   est affichée : liste des termes (T),  liste  des  fichiers  (F),  liste  des
  294.   termes trouvés (S). 
  295.       Pour passer d'une liste à l'autre, appuyez sur le bouton droit de la
  296.   souris tout en appuyant sur une des touches SHIFT, ou appuyez sur la  touche
  297.   <TAB>. Lorsque la liste des fichiers est affichée et que sélectionnez un des
  298.   fichiers de cette liste, ADoc repasse automatiquement à la liste des  termes
  299.   et affiche la liste des termes du fichier que vous avez choisi.
  300.  
  301.       Si aucune autre fenêtre n'est ouverte, la requête de  terme  dispose
  302.   d'un menu avec quatre options :
  303.  
  304.       Ouvre fichier   voir paragraphe LeMenuSpecial
  305.       Cherche         voir paragraphe Recherche
  306.       Iconifie        voir paragraphe LeMenuProjet
  307.       Quitte          vous permet de quitter ADoc
  308.    
  309. GestionDesFenêtres
  310.    
  311.       Lorsque vous sélectionnez un terme,  ADoc  ouvre  une  fenêtre  pour
  312.   afficher le texte correspondant. Si le terme est défini plusieurs fois  dans
  313.   le même fichier, ou dans plusieurs fichiers différents, toutes les lignes de
  314.   texte seront mises à la suite les unes des autres,  et  affichées  dans  une
  315.   seule fenêtre. La hauteur de  la  fenêtre  dépend  du  nombre  de  lignes  à
  316.   afficher. S'il y a trop de lignes, seule la première page sera  affichée  et
  317.   ADoc ajoutera deux gadgets en forme  de  flèches  (dans  le  coin  supérieur
  318.   droit) à la fenêtre, pour vous permettre de faire défiler le texte.
  319.  
  320.       Bien entendu, il est possible d'avoir plusieurs fenêtres ouvertes  à
  321.   la fois. Dans ce cas, la fenêtre qui était active lors de l'ouverture  d'une
  322.   nouvelle fenêtre est considérée comme la fenêtre parente de cette  dernière.
  323.       Par  défaut,  les  fenêtres  disposent  des  gadgets  standards   de
  324.   fermeture, de déplacement, de  changement  de  plan,  et  de  changement  de
  325.   taille. Si vous modifiez la taille d'une fenêtre, ADoc ajoutera ou  enlevera
  326.   automatiquement les gadgets en forme de flèches suivant les besoins.  Chaque
  327.   fenêtre dispose également de trois menus, les menus  "Projet",  "Outils"  et
  328.   "Spécial" (ces menus sont décrits aux paragraphes LeMenuProjet, LeMenuOutils
  329.   et LeMenuSpécial). Notez enfin que ADoc reconnait les touches suivantes :
  330.  
  331.       HELP            rappelle les touches reconnues
  332.       ESC             ferme la fenêtre courante
  333.       HAUT            page précédente
  334.       BAS             page suivante
  335.       BACKSPACE       ouvre la fenêtre parente
  336.       Shift-HAUT      terme précédent
  337.       Shift-BAS       terme suivant
  338.    
  339.       Si vous cliquez sur un mot quelconque, ce mot sera affiché dans  une
  340.   couleur différente. Si vous cliquez  une  seconde  fois  sur  ce  mot,  ADoc
  341.   lancera automatiquement la recherche du terme correspondant, dans  tous  les
  342.   fichiers ouverts. En  cas  d'échec  l'écran  flashera,  sinon  une  nouvelle
  343.   fenêtre apparaitra.
  344.  
  345. LeMenuProjet
  346.    
  347.   Autre terme 
  348.       Fait apparaître la requête de terme (voir paragraphe RequêteDeTerme).
  349.  
  350.   Imprime 
  351.       Imprime  le  texte  contenu  dans  la  fenêtre  active.  Notez  que  les
  352.       éventuelles  séquences  ANSI  seront   correctement   interprétées   par
  353.       l'imprimante.
  354.  
  355.   Iconifie 
  356.       Met ADoc en sommeil : si ADoc avait ouvert son propre écran celui-ci est
  357.       fermé, puis toutes les fenêtres disparaissent et ADoc ouvre  une  petite
  358.       fenêtre en haut de l'écran du Workbench. Si vous cliquez sur  le  gadget
  359.       de fermeture de cette fenêtre, ADoc vous demandera confirmation avant de
  360.       quitter. Pour "réveiller" ADoc, activez la fenêtre  et  appuyez  sur  le
  361.       bouton droit de la souris. 
  362.       Normalement, ADoc garde en mémoire toutes les lignes de  texte  afin  de
  363.       pouvoir remettre rapidement toutes les fenêtres en  place  lors  de  son
  364.       réveil. Ceci a  l'inconvénient  de  ne  pas  libérer  toute  la  mémoire
  365.       possible aussi, lorsque vous lui demanderez de  s'iconifier,  ADoc  vous
  366.       demandera si vous voulez fermer toutes les fenêtres.  Si  vous  répondez
  367.       oui, la mémoire sera complètement libérée, et lorsque  vous  réveillerez
  368.       ADoc, il affichera la requête de terme.
  369.  
  370.   Aide... 
  371.       Rappelle quelles touches ADoc reconnait (équivalent  à  appuyer  sur  la
  372.       touche HELP).
  373.  
  374.   A propos... 
  375.       Affiche quelques informations sur ADoc.  Cliquez  à  l'intérieur  de  la
  376.       fenêtre ou appuyez sur une touche pour continuer.
  377.  
  378.   Quitter 
  379.       Vous permet de quitter ADoc (avec confirmation). 
  380.    
  381. LeMenuOutils
  382.    
  383.   Ecran avant 
  384.       Permet d'utiliser ADoc sur un écran déjà ouvert (par  exemple  celui  de
  385.       votre éditeur de texte). Il vous suffit de  mettre  l'écran  sur  lequel
  386.       vous voulez placer ADoc au premier plan, puis de le faire  glisser  vers
  387.       le bas pour dévoiler l'écran  où  est  ADoc.  Sélectionnez  alors  cette
  388.       option : ADoc ferme toutes les fenêtres ouvertes,  ferme  éventuellement
  389.       son écran, et ré-ouvre les fenêtres sur l'écran au premier plan.
  390.  
  391.        
  392.  
  393.                  NOTE IMPORTANTE :
  394.  
  395.       Vous aurez certainement droit à une visite  du  "Gourou"  si
  396.       l'écran où vous avez placé ADoc est  fermé  avant  que  vous
  397.       n'ayez quitté ADoc (ou que vous ne l'ayez placé sur un autre
  398.       écran) 
  399.        
  400.       Notez que cette commande ne marchera pas si vous n'avez pas  indiqué  de
  401.       police de caractères à utiliser (voir  paragraphe  AppelDepuisLeCLI)  et
  402.       que la police de l'écran au premier plan ne convient pas.
  403.  
  404.   Ferme tout 
  405.       Vous permet de fermer toutes les fenêtres d'un  seul  coup.  Après  vous
  406.       avoir demandé confirmation, ADoc fermera les fenêtres  et  affichera  la
  407.       requête de terme.
  408.  
  409.   Cherche 
  410.       Vous permet de lancer une recherche (voir le paragraphe Recherche).
  411.  
  412.   Information 
  413.       Affiche le nombre de fichiers et de termes  disponibles,  ainsi  que  le
  414.       nombre de fenêtres ouvertes et  de  lignes  affichées.  Cliquez  sur  le
  415.       gadget "Ok" pour continuer. 
  416.    
  417. LeMenuSpécial
  418.    
  419.   Ouvre fichier 
  420.       Vous permet d'ouvrir un fichier  de  documentation  supplémentaire.  Une
  421.       requête de fichier apparait afin que vous puissiez indiquer le fichier à
  422.       ouvrir.
  423.  
  424.   Ferme fichier 
  425.       Vous permet de fermer le fichier courant (c'est-à-dire le fichier où est
  426.       défini le terme affiché  dans  la  fenêtre  active).  Après  vous  avoir
  427.       demandé confirmation, ADoc fermera toutes les fenêtres  correspondant  à
  428.       ce fichier puis fermera le fichier. 
  429.       Notez que cette commande ne marchera que si au moins deux fichiers  sont
  430.       ouverts.
  431.  
  432.   Une fenêtre 
  433.       Si cette option est sélectionnée, ADoc n'ouvrira qu'une seule fenêtre  à
  434.       la fois. 
  435.    
  436. Recherche
  437.    
  438.       ADoc est capable de chercher jusqu'à  quatre  chaines  simultanément
  439.   dans  les  lignes  de  texte,  puis   d'afficher   la   liste   des   termes
  440.   correspondants.  Lorsque  vous  sélectionnez  l'option  "Cherche"  du   menu
  441.   "Outils", une fenêtre apparait  avec  quatre  gadgets  de  chaine.  Il  y  a
  442.   également  un  gadget  "ANNULER"  pour  abandonner  l'opération,  un  gadget
  443.   "VALIDER" pour lancer la recherche, et un menu "Options" :
  444.  
  445.       min = MAJ 
  446.       Demande à ADoc de ne pas différencier les minuscules des  majuscules
  447.       lors de la recherche.
  448.  
  449.       Toutes chaines 
  450.       Normalement, ADoc cherche tous les termes qui  contiennent  une  des
  451.       chaines que vous avez entrées. Cette option vous permet de  chercher
  452.       au  contraire  les  termes  qui  contiennent  TOUTES   les   chaines
  453.       indiquées.
  454.  
  455.       Tous fichiers 
  456.       Demande à ADoc de faire la recherche dans tous les fichiers ouverts,
  457.       et non seulement dans le fichier courant. 
  458.    
  459.       Lorsque vous lancez la recherche, une boîte de requête apparait.  Le
  460.   gadget "Arrêter"  vous  permet  d'interrompre  la  recherche.  Une  fois  la
  461.   recherche terminée, l'écran flashera si aucun terme n'a été  trouvé.  Sinon,
  462.   la requête de terme apparaitra, et affichera la liste  des  termes  trouvés.
  463.   Cette liste est triée, et elle est conservée en mémoire jusqu'à ce que  vous
  464.   lanciez une autre recherche.
  465.  
  466. ConceptsAvancés
  467.    
  468.       Depuis la v4.00, il est possible  d'associer  une  image  IFF  à  un
  469.   terme. Cette image sera chargée en même temps que le texte, et affichée dans
  470.   le  même  fenêtre.  Pour  utiliser  cette  possibilité,   il   vous   suffit
  471.   d'introduire dans le texte une ligne de la forme :
  472.  
  473. .        adoc@<position> <nom image>
  474.    
  475.  
  476.   où <position> vaut "top", "bottom", "left" ou "right". L'image sera affichée
  477.   contre le bord indiqué. Par exemple, si vous écrivez une spécification :
  478.  
  479. .        adoc@right doc:exec/schema1.pic
  480.    
  481.  
  482.   l'image "doc:exec/shema1.pic" sera affichée  contre  le  bord  droit  de  la
  483.   fenêtre. 
  484.       ADoc peut charger une image d'une résolution et/ou  d'un  nombre  de
  485.   plans différents de ceux de l'écran courant.  La  palette  de  l'écran  sera
  486.   modifiée à partir de celle de l'image.
  487.  
  488.       La version 1.40 de ADoc a introduit la notion d'alias,  c'est-à-dire
  489.   un moyen de d'associer un même texte à  plusieurs  termes  différents,  sans
  490.   avoir à répéter le texte plusieurs fois. Pour créer un alias, il vous suffit
  491.   de définir un terme de la façon suivante :
  492.  
  493.       nom1 alias nom2
  494.  
  495.   Le premier caractère de "nom1" doit, comme pour toute définition  de  terme,
  496.   se trouver en colonne 1.  Il  doit  y  avoir  au  moins  un  espace  ou  une
  497.   tabulation entre  les  trois  mots.  Le  mot  "alias"  doit  être  écrit  en
  498.   minuscules. L'effet de cette définition est le suivant  :  si  l'utilisateur
  499.   demande à accéder au terme "nom1", ADoc affichera automatiquement  le  terme
  500.   "nom2". Les alias apparaissent dans la requête de terme,  et  sont  pris  en
  501.   compte par la fonction de recherche. Notez  qu'il  n'y  a  *AUCUN*  test  de
  502.   récursivité entre les différents alias ! 
  503.       Une  application  pratique  de  ces  alias  est   par   exemple   la
  504.   documentation d'une bibliothèque  de  fonctions  :  il  arrive  souvent  que
  505.   plusieurs fonctions soient définies ensemble. Avec le mécanisme des alias on
  506.   peut accéder à cette définition avec le nom de chaque fonction, alors que le
  507.   texte n'est défini qu'une seule fois.
  508.  
  509.       ADoc est capable d'associer automatiquement  plusieurs  fichiers  de
  510.   documentation. Il vous suffit d'indiquer le (ou les)  noms  des  fichiers  à
  511.   associer sur la première ligne du fichier auquel vous voulez  les  associer.
  512.   Si cette ligne reste vide, ou commence par un espace ou une tabulation,  son
  513.   contenu est ignoré. Les noms peuvent être séparés par des espaces ou par une
  514.   virgule. Vous pouvez indiquer un nom de  répertoire,  auquel  cas  tous  les
  515.   fichiers de ce répertoire seront  ouverts  (sauf  les  fichiers  ".info"  et
  516.   ".index").
  517.  
  518.       Pour étendre le jeu des caractères pouvant  être  utilisés  dans  un
  519.   terme, il vous suffit  d'indiquer  les  caractères  supplémentaires  sur  le
  520.   seconde ligne du fichier de documentation. Si cette  ligne  reste  vide,  ou
  521.   commence par un espace ou une tabulation, son  contenu  est  ignoré.  Sinon,
  522.   tous les caractères de cette ligne  (jusqu'au  premier  espace,  tabulation,
  523.   barre de fraction ou saut de page) sont ajoutés au  jeu  de  caractères  par
  524.   défaut. Notez que cette extension du jeu de caractères ne concernera que  ce
  525.   fichier.
  526.  
  527.       ADoc est capable de charger directement des fichiers  compactés  par
  528.   "PowerPacker", à condition  que  la  bibliothèque  "powerpacker.library"  se
  529.   trouve dans le répertoire "LIBS:". Il  n'est  pas  nécessaire  de  créer  le
  530.   fichier d'index avant le compactage, mais cela est recommandé. ADoc refusera
  531.   de charger un fichier crypté. 
  532.       Après  décompactage,  le  fichier  sera  recopié  dans  un   fichier
  533.   temporaire  placé  dans  le  répertoire  "T:".  L'utilisation  de   fichiers
  534.   compactés peut donc poser des problèmes de mémoire, particulièrement  si  le
  535.   répertoire "T:" se trouve sur le disque "RAM:". Le fichier  temporaire  sera
  536.   détruit après sa fermeture.
  537.  
  538. ModeAREXX
  539.    
  540.       ADoc  ouvre  systématiquement  un  port  compatible   AREXX,   nommé
  541.   "ADoc_rexx". Les messages sur ce port sont attendus en même  temps  que  les
  542.   messages Intuition sur les fenêtres de texte, et peuvent prendre les  formes
  543.   suivantes :
  544.  
  545.       QUIT            quitte ADoc 
  546.       REQUEST         fait apparaître la requête de terme 
  547.       FSCREEN         ADoc ré-ouvre ses fenêtres sur  l'écran  au  premier
  548.               plan 
  549.       TOFRONT         fait passer l'écran de ADoc au premier plan 
  550.       TOBACK          fait passer l'écran de ADoc au dernier plan 
  551.       FIND terme      lance la recherche du terme indiqué, et  affiche  le
  552.               texte correspondant s'il est trouvé 
  553.       OPEN fichier    ouvre le fichier de documentation indiqué 
  554.    
  555.       Le code retour (variable RC) est en général à zéro,  sauf  dans  les
  556.   cas suivants : requête inconnue (code retour 20), requête "FIND terme"  avec
  557.   "terme" non trouvé (code retour 5), requête  "request"  et  pas  de  nouveau
  558.   terme choisi (code retour 5). Voici  un  exemple  de  programme  AREXX,  qui
  559.   demande de l'aide sur le terme "alias" :
  560.  
  561.       /* Demande de l'aide sur "alias" */
  562.       ADDRESS "ADoc_rexx"
  563.       "FIND alias"
  564.       IF RC = 5 THEN SAY "not found !"
  565.    
  566.       Notez les guillemets autour des commandes ! 
  567.       Si vous lancez  ADoc  avec  l'option  AREXX,  le  fonctionnement  du
  568.   programme sera un peu différent : une fois le(s) fichier(s) de documentation
  569.   ouvert(s), ADoc n'ouvrira pas la requête de terme mais affichera le  message
  570.   "En attente d'un message AREXX" et attendra des messages sur le  port  AREXX
  571.   (ou CTRL-C pour quitter). De plus, lorsque la dernière fenêtre sera  fermée,
  572.   le programme ne se terminera pas  mais  repassera  en  attente  de  messages
  573.   AREXX.
  574.  
  575. Support_des_fichiers_AutoDoc
  576.    
  577.       ADoc est capable de reconnaitre et d'utiliser les  fichiers  AutoDoc
  578.   de Commodore. Dans la plupart des cas, aucune modification de  ces  fichiers
  579.   n'est nécessaire, mais il est quand même conseillé de vérifier leur format :
  580.   il doit y avoir au moins deux lignes vides au début, suivies de la table des
  581.   matières, et chaque terme doit commencer en colonne 1. 
  582.       Dans certains cas, il manque les  lignes  vides  au  début,  et  les
  583.   termes commencent en colonne 2, précédés par un caractères  "saut  de  page"
  584.   (CTRL-L). Le programme "AutoConvert", distribué avec ADoc, vous permettra de
  585.   convertir ces fichiers au bon format (Note: ce programme ne peut  s'utiliser
  586.   que depuis le CLI). Dans tous les autres cas, il vous faudra  convertir  les
  587.   fichiers "à la main".
  588.  
  589. Support_des_fichiers_AmigaGuide
  590.    
  591.       ADoc est désormais capable de  reconnaitre  un  fichier  AmigaGuide,
  592.   d'en construire l'index et d'en afficher le contenu, en gérant  correctement
  593.   les différentes formes de la directive @node :
  594.  
  595.       @node nom
  596.       @node "titre"
  597.       @node nom "titre"
  598.    
  599.   Dans ce dernier cas, un alias "nom" est automatiquement défini pour le terme
  600.   "titre". La directive "@title" est reconnue également. 
  601.       Comme ADoc ne permet pas d'utiliser des espaces  dans  les  noms  de
  602.   termes, ceux-ci sont remplacés par un caractère souligné. Les liens dans  le
  603.   texte sont affichés en gras. Les noms étant tronqués  à  32  caractères,  il
  604.   pourra arriver que certains liens ne fonctionnent pas. Notez que  ADoc  gère
  605.   les liens entre fichiers, comme par exemple :
  606.  
  607.             @{"toto" link help:general/titi}
  608.    
  609.   Pour permettre cela, les  délimiteurs  sont  automatiquement  initialisés  à
  610.   ":/." pour tous les fichiers AmigaGuide.
  611.  
  612. LesMessagesDeADoc
  613.    
  614.       Lorsqu'une erreur se produit, ADoc affiche dans une  petite  fenêtre
  615.   un nom (de fichier en général) et un code d'erreur.  Ce  code  d'erreur  est
  616.   soit un code d'erreur AmigaDOS soit un code interne. Dans  le  premier  cas,
  617.   reportez-vous à votre manuel de l'AmigaDOS (ou utilisez la commande "Fault")
  618.   pour avoir plus de détails sur ce code d'erreur. 
  619.       Les codes d'erreur internes sont :
  620.  
  621.       -1      fichier vide
  622.       -2      erreur de lecture
  623.       -3      fichier incorrect (mauvais format, etc...)
  624.       -4      fichier compacté, et "powerpacker.library" absente
  625.       -5      problème lors du décompactage
  626.       -6      spécification d'image incorrecte
  627.       -7      erreur lors du chargement de l'image
  628.    
  629.